Package: github.com/K-Phoen/grabana/graph

package graph Import Path github.com/K-Phoen/grabana/graph (on go.dev) Dependency Relation imports 11 packages, and imported by one package

Involved Source Files graph.go

Package-Level Type Names (total 5)

/* sort by: alphabet | popularity */

type DrawMode uint8 (basic type) DrawMode represents a type of visualization that will be drawn in the graph (lines, bars, points) As Inputs Of (at least one exported) func Draw(modes ...DrawMode) Option As Types Of (total 3) const Bars const Lines const Points

type Graph (struct) Graph represents a graph panel. Fields (total 2) Alert *alert.Alert Builder *sdk.Panel As Outputs Of (at least one exported) func New(title string, options ...Option) (*Graph, error)

type LegendOption uint16 (basic type) LegendOption allows to configure a legend. As Inputs Of (at least one exported) func Legend(opts ...LegendOption) Option As Types Of (total 10) const AsTable const Avg const Current const Hide const Max const Min const NoNullSeries const NoZeroSeries const Total const ToTheRight

type NullValue string (basic type) NullValue describes how null values are displayed. As Inputs Of (at least one exported) func Null(mode NullValue) Option As Types Of (total 3) const AsNull const AsZero const Connected

type Option (func) Option represents an option that can be used to configure a graph panel. As Outputs Of (at least 24) func Alert(name string, opts ...alert.Option) Option func DataSource(source string) Option func Description(content string) Option func Draw(modes ...DrawMode) Option func Fill(value int) Option func Height(height string) Option func LeftYAxis(opts ...axis.Option) Option func Legend(opts ...LegendOption) Option func LineWidth(value uint) Option func Links(panelLinks ...links.Link) Option func Null(mode NullValue) Option func PointRadius(value float32) Option func Repeat(repeat string) Option func RepeatDirection(direction sdk.RepeatDirection) Option func RightYAxis(opts ...axis.Option) Option func SeriesOverride(opts ...series.OverrideOption) Option func Span(span float32) Option func Staircase() Option func Transparent() Option func WithGraphiteTarget(query string, options ...graphite.Option) Option func WithInfluxDBTarget(query string, options ...influxdb.Option) Option func WithPrometheusTarget(query string, options ...prometheus.Option) Option func WithStackdriverTarget(target *stackdriver.Stackdriver) Option func XAxis(opts ...axis.Option) Option As Inputs Of (at least 2) func New(title string, options ...Option) (*Graph, error) func github.com/K-Phoen/grabana/row.WithGraph(title string, options ...Option) row.Option

Package-Level Functions (total 25)

func Alert(name string, opts ...alert.Option) Option Alert creates an alert for this graph.

func DataSource(source string) Option DataSource sets the data source to be used by the graph.

func Description(content string) Option Description annotates the current visualization with a human-readable description.

func Draw(modes ...DrawMode) Option Draw specifies how the graph will be drawn.

func Fill(value int) Option Fill defines the amount of color fill for a series (default 1, max 10, 0 is none).

func Height(height string) Option Height sets the height of the panel, in pixels. Example: "400px".

func LeftYAxis(opts ...axis.Option) Option LeftYAxis configures the left Y axis.

func Legend(opts ...LegendOption) Option Legend defines what should be shown in the legend.

func LineWidth(value uint) Option LineWidth defines the width of the line for a series (default 1, max 10, 0 is none).

func Links(panelLinks ...links.Link) Option Links adds links to be displayed on this panel.

func New(title string, options ...Option) (*Graph, error) New creates a new graph panel.

func Null(mode NullValue) Option Null configures how null values are displayed.

func PointRadius(value float32) Option PointRadius adjusts the size of points when Points are selected as Draw Mode.

func Repeat(repeat string) Option Repeat configures repeating a panel for a variable

func RepeatDirection(direction sdk.RepeatDirection) Option RepeatDirection configures repeating vertical or horizontal

func RightYAxis(opts ...axis.Option) Option RightYAxis configures the right Y axis.

func SeriesOverride(opts ...series.OverrideOption) Option SeriesOverride configures how null values are displayed. See https://grafana.com/docs/grafana/latest/panels/field-options/

func Span(span float32) Option Span sets the width of the panel, in grid units. Should be a positive number between 1 and 12. Example: 6.

func Staircase() Option Staircase draws adjacent points as staircase.

func Transparent() Option Transparent makes the background transparent.

func WithGraphiteTarget(query string, options ...graphite.Option) Option WithGraphiteTarget adds a Graphite target to the table.

func WithInfluxDBTarget(query string, options ...influxdb.Option) Option WithInfluxDBTarget adds an InfluxDB target to the graph.

func WithPrometheusTarget(query string, options ...prometheus.Option) Option WithPrometheusTarget adds a prometheus query to the graph.

func WithStackdriverTarget(target *stackdriver.Stackdriver) Option WithStackdriverTarget adds a stackdriver query to the graph.

func XAxis(opts ...axis.Option) Option XAxis configures the X axis.

Package-Level Constants (total 16)

const AsNull NullValue = "null" AsNull treats null values as null.

const AsTable LegendOption = 1 AsTable displays the legend as a table.

const AsZero NullValue = "null as zero" AsZero treats null values as zero values.

const Avg LegendOption = 5 Avg displays the average of the series.

const Bars DrawMode = 0 Bars will display bars.

const Connected NullValue = "connected" Connected connects null values.

const Current LegendOption = 6 Current displays the current value of the series.

const Hide LegendOption = 0 Hide keeps the legend from being displayed.

const Lines DrawMode = 1 Lines will display lines.

const Max LegendOption = 4 Max displays the largest value of the series.

const Min LegendOption = 3 Min displays the smallest value of the series.

const NoNullSeries LegendOption = 8 NoNullSeries hides series with only null values from the legend.

const NoZeroSeries LegendOption = 9 NoZeroSeries hides series with only 0 values from the legend.

const Points DrawMode = 2 Points will display points.

const Total LegendOption = 7 Total displays the total value of the series.

const ToTheRight LegendOption = 2 ToTheRight displays the legend on the right side of the graph.